<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>Docs For Class Madoqua_Application</title>
    <link rel="stylesheet" type="text/css" href="../media/style.css" />
    <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
  </head>
  <body>
  
    <h1>Madoqua :: Docs For Class Madoqua_Application</h1>

    <table width="100%">
      <tr valign="top">
        <td class="menu">
                                <div class="package">
              <div id="todolist">
                <p><a href="../todolist.html">Todo List</a></p>
              </div>
            </div>
                    <h2>Packages:</h2>
          <div class="package">
            <ul>
                              <li>
                  <a href="../classtrees_default.html">default</a>
                </li>
                              <li>
                  <a href="../classtrees_Application.html">Application</a>
                </li>
                              <li>
                  <a href="../classtrees_Cache.html">Cache</a>
                </li>
                              <li>
                  <a href="../classtrees_Controller.html">Controller</a>
                </li>
                              <li>
                  <a href="../classtrees_Db.html">Db</a>
                </li>
                              <li>
                  <a href="../classtrees_Filter.html">Filter</a>
                </li>
                              <li>
                  <a href="../classtrees_Form.html">Form</a>
                </li>
                              <li>
                  <a href="../classtrees_Install.html">Install</a>
                </li>
                              <li>
                  <a href="../classtrees_Loader.html">Loader</a>
                </li>
                              <li>
                  <a href="../classtrees_Madoqua_Exception.html">Madoqua_Exception</a>
                </li>
                              <li>
                  <a href="../classtrees_Madoqua_Observer.html">Madoqua_Observer</a>
                </li>
                              <li>
                  <a href="../classtrees_Madoqua_Plugin.html">Madoqua_Plugin</a>
                </li>
                              <li>
                  <a href="../classtrees_Madoqua_View.html">Madoqua_View</a>
                </li>
                              <li>
                  <a href="../classtrees_Module.html">Module</a>
                </li>
                              <li>
                  <a href="../classtrees_Naneau_Plugin.html">Naneau_Plugin</a>
                </li>
                              <li>
                  <a href="../classtrees_Redirector.html">Redirector</a>
                </li>
                              <li>
                  <a href="../classtrees_Search.html">Search</a>
                </li>
                              <li>
                  <a href="../classtrees_Validate.html">Validate</a>
                </li>
                              <li>
                  <a href="../classtrees_View.html">View</a>
                </li>
                          </ul>
          </div>
                                                                    <h2>Classes:</h2>
                <ul>
		    		<li><a href="../Application/Madoqua_Application.html">Madoqua_Application</a></li>    	  </ul>
                              </td>
        <td>
          <table style="width:750px;" cellpadding="10" cellspacing="10px">
            <tr>
              <td valign="top">
                                                                  <h2>Application::Madoqua_Application</h2>
                                <div class="menu">
          
                                                          
                                                                                                                                                                                                                                                                                                                                                                                                                      [ <a href="../index.html">Index</a> ]
                      [ <a href="../classtrees_Application.html">Application classes</a> ]
            [ <a href="../elementindex_Application.html">Application elements</a> ]
                    [ <a href="../elementindex.html">All elements</a> ]
          [ <a href="../errors.html">Errors</a> ]
                </div>
<a name="sec-description"></a>
<h2>Class Madoqua_Application</h2>

<p>Madoqua_Application</p><div><p>all application related stuff. Most of this should be separated into different components,  such as a custom FC and a custom DB.</p></div>		




  <strong>Author(s):</strong>
  <ul>
                </ul>

  <table>
    	  		<tr>
		  <td>
		    <strong>Todo:</strong>&nbsp;&nbsp;
		  </td>
		  <td>read this phpdoc-block and fix it =]</td>
		</tr>
	        </table>





  <a name="sec-var-summary"></a>
  <h2>Member Variables</h2>
  <table class="summary">
                  <tr>
          <td class="right">
            <em>protected</em>            static
            <em>array</em>          </td>
          <td>
            <code>
              $_adminModules
               = <span class="var-default">array('admin', 'blogAdmin')</span>            </code>
            <br /><div style="margin-left: 20px">modules that are just for admins, this is part of the design. Madoqua does not have  an ACL-based approach for security. Instead we have binary exclusion of admins and  non-admins. KISS ftw.</div>                      </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>            static
            <em>string</em>          </td>
          <td>
            <code>
              $_applicationDirectory
                          </code>
            <br /><div style="margin-left: 20px">the application directory</div>                      </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>            static
            <em>Zend_Config_Xml</em>          </td>
          <td>
            <code>
              $_configuration
                          </code>
            <br /><div style="margin-left: 20px">the configuration</div>                      </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>            static
            <em>Zend_Db_Adapter_Abstract</em>          </td>
          <td>
            <code>
              $_database
                          </code>
            <br /><div style="margin-left: 20px">database adapter</div>                      </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>            static
            <em>string</em>          </td>
          <td>
            <code>
              $_rootDirectory
                          </code>
            <br /><div style="margin-left: 20px">&quot;root&quot; directory</div>                      </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>            static
            <em>Zend_Session_Namespace</em>          </td>
          <td>
            <code>
              $_session
                          </code>
            <br /><div style="margin-left: 20px">session namespace</div>                      </td>
        </tr>
                                                                            </table>


  <a name="sec-method-summary"></a>
  <h2>Method Summary</h2>
  <table class="summary">
                  <tr>
          <td class="right">
            <em>protected</em>            static
                        <em>void</em>          </td>
          <td>
            <code>
              <a href="#addPlugins"><b>addPlugins</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">add plugins to the FC</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>array</em>          </td>
          <td>
            <code>
              <a href="#getAdminModules"><b>getAdminModules</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">get a list of modules that are for admins only</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>string</em>          </td>
          <td>
            <code>
              <a href="#getApplicationDirectory"><b>getApplicationDirectory</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">get the application directory</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>Zend_Config_Xml|bool</em>          </td>
          <td>
            <code>
              <a href="#getConfiguration"><b>getConfiguration</b></a>(
                                                                  [                  $reload
                   = false]                               )
            </code>
            <br /><div style="margin-left: 20px">get the application's configuration</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>Zend_Db_Adapter_Abstract</em>          </td>
          <td>
            <code>
              <a href="#getDatabase"><b>getDatabase</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">get the database</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>unknown</em>          </td>
          <td>
            <code>
              <a href="#getDataDirectory"><b>getDataDirectory</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">get the Data directory</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>Zend_Controller_Front</em>          </td>
          <td>
            <code>
              <a href="#getFront"><b>getFront</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">get the front controller</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>array</em>          </td>
          <td>
            <code>
              <a href="#getModules"><b>getModules</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">get a list of modules currently available</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>string</em>          </td>
          <td>
            <code>
              <a href="#getRootDirectory"><b>getRootDirectory</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">get the root directory</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>Zend_Session_Namespace</em>          </td>
          <td>
            <code>
              <a href="#getSession"><b>getSession</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">get the session namespace</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>string</em>          </td>
          <td>
            <code>
              <a href="#getTempDirectory"><b>getTempDirectory</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">get the temp directory</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>string</em>          </td>
          <td>
            <code>
              <a href="#getVersion"><b>getVersion</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">get a version number for this installation</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>bool</em>          </td>
          <td>
            <code>
              <a href="#inDevelopment"><b>inDevelopment</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">Evaluate application state</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>bool</em>          </td>
          <td>
            <code>
              <a href="#isInstalled"><b>isInstalled</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">figure out whether the application has been installed</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>void</em>          </td>
          <td>
            <code>
              <a href="#setApplicationDirectory"><b>setApplicationDirectory</b></a>(
                                                                                    $applicationDirectory
                                                 )
            </code>
            <br /><div style="margin-left: 20px">set the application directory</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>void</em>          </td>
          <td>
            <code>
              <a href="#setRootDirectory"><b>setRootDirectory</b></a>(
                                                                                    $rootDirectory
                                                 )
            </code>
            <br /><div style="margin-left: 20px">set the &quot;root&quot; directory</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>protected</em>            static
                        <em>void</em>          </td>
          <td>
            <code>
              <a href="#startLayout"><b>startLayout</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">start layout</div>          </td>
        </tr>
                        <tr>
          <td class="right">
            <em>public</em>            static
                        <em>void</em>          </td>
          <td>
            <code>
              <a href="#startMvc"><b>startMvc</b></a>(
               )
            </code>
            <br /><div style="margin-left: 20px">start MVC</div>          </td>
        </tr>
                                                                                                                                                                                                    </table>


  <a name="sec-methods"></a>
  <h2>Methods</h2>
  <a name='method_detail'></a>
      <a name="methodaddPlugins" id="addPlugins"><!-- --></a>

    <h3>addPlugins</h3>

    <div class="method-signature">
      static void
      addPlugins(
      )
    </div>

      <p>add plugins to the FC</p>      
      
      
      
      
      
        <a name="methodgetAdminModules" id="getAdminModules"><!-- --></a>

    <h3>getAdminModules</h3>

    <div class="method-signature">
      static array
      getAdminModules(
      )
    </div>

      <p>get a list of modules that are for admins only</p>      
      
      
      
      
      
        <a name="methodgetApplicationDirectory" id="getApplicationDirectory"><!-- --></a>

    <h3>getApplicationDirectory</h3>

    <div class="method-signature">
      static string
      getApplicationDirectory(
      )
    </div>

      <p>get the application directory</p>      
      
      
      
      
      
        <a name="methodgetConfiguration" id="getConfiguration"><!-- --></a>

    <h3>getConfiguration</h3>

    <div class="method-signature">
      static Zend_Config_Xml|bool
      getConfiguration(
                                  [
          $reload
           = false]              )
    </div>

      <p>get the application's configuration</p>      
              <h4>Parameters:</h4>
        <table class="detail">
          <thead>
            <tr>
              <th>Name</th>
              <th>Type</th>
              <th class="desc">Description</th>
            </tr>
          </thead>
          <tbody>
                          <tr>
                <td><code>$reload</code></td>
                <td><em></em></td>
                <td>
                                  </td>
              </tr>
                      </tbody>
        </table>
      
      
      
      
      
        <a name="methodgetDatabase" id="getDatabase"><!-- --></a>

    <h3>getDatabase</h3>

    <div class="method-signature">
      static Zend_Db_Adapter_Abstract
      getDatabase(
      )
    </div>

      <p>get the database</p><div><p>with any luck, this method won't get called during execution. Go go caching!</p><p>also, go go dik-diks.</p></div>      
      
      
      
      
      
        <a name="methodgetDataDirectory" id="getDataDirectory"><!-- --></a>

    <h3>getDataDirectory</h3>

    <div class="method-signature">
      static unknown
      getDataDirectory(
      )
    </div>

      <p>get the Data directory</p>      
      
      
      
      
      
        <a name="methodgetFront" id="getFront"><!-- --></a>

    <h3>getFront</h3>

    <div class="method-signature">
      static Zend_Controller_Front
      getFront(
      )
    </div>

      <p>get the front controller</p>      
      
      
      
      
      
        <a name="methodgetModules" id="getModules"><!-- --></a>

    <h3>getModules</h3>

    <div class="method-signature">
      static array
      getModules(
      )
    </div>

      <p>get a list of modules currently available</p>      
      
      
      
      
      
        <a name="methodgetRootDirectory" id="getRootDirectory"><!-- --></a>

    <h3>getRootDirectory</h3>

    <div class="method-signature">
      static string
      getRootDirectory(
      )
    </div>

      <p>get the root directory</p>      
      
      
      
      
      
        <a name="methodgetSession" id="getSession"><!-- --></a>

    <h3>getSession</h3>

    <div class="method-signature">
      static Zend_Session_Namespace
      getSession(
      )
    </div>

      <p>get the session namespace</p>      
      
      
      
      
      
        <a name="methodgetTempDirectory" id="getTempDirectory"><!-- --></a>

    <h3>getTempDirectory</h3>

    <div class="method-signature">
      static string
      getTempDirectory(
      )
    </div>

      <p>get the temp directory</p>      
      
      
      
      
      
        <a name="methodgetVersion" id="getVersion"><!-- --></a>

    <h3>getVersion</h3>

    <div class="method-signature">
      static string
      getVersion(
      )
    </div>

      <p>get a version number for this installation</p>      
      
      
      
      
      
        <a name="methodinDevelopment" id="inDevelopment"><!-- --></a>

    <h3>inDevelopment</h3>

    <div class="method-signature">
      static bool
      inDevelopment(
      )
    </div>

      <p>Evaluate application state</p>      
      
      
      
      
      
        <a name="methodisInstalled" id="isInstalled"><!-- --></a>

    <h3>isInstalled</h3>

    <div class="method-signature">
      static bool
      isInstalled(
      )
    </div>

      <p>figure out whether the application has been installed</p>      
      
      
      
      
      
        <a name="methodsetApplicationDirectory" id="setApplicationDirectory"><!-- --></a>

    <h3>setApplicationDirectory</h3>

    <div class="method-signature">
      static void
      setApplicationDirectory(
                                  string
          $applicationDirectory
                        )
    </div>

      <p>set the application directory</p>      
              <h4>Parameters:</h4>
        <table class="detail">
          <thead>
            <tr>
              <th>Name</th>
              <th>Type</th>
              <th class="desc">Description</th>
            </tr>
          </thead>
          <tbody>
                          <tr>
                <td><code>$applicationDirectory</code></td>
                <td><em>string</em></td>
                <td>
                                  </td>
              </tr>
                      </tbody>
        </table>
      
      
      
      
      
        <a name="methodsetRootDirectory" id="setRootDirectory"><!-- --></a>

    <h3>setRootDirectory</h3>

    <div class="method-signature">
      static void
      setRootDirectory(
                                  $rootDirectory
          $rootDirectory
                        )
    </div>

      <p>set the &quot;root&quot; directory</p>      
              <h4>Parameters:</h4>
        <table class="detail">
          <thead>
            <tr>
              <th>Name</th>
              <th>Type</th>
              <th class="desc">Description</th>
            </tr>
          </thead>
          <tbody>
                          <tr>
                <td><code>$rootDirectory</code></td>
                <td><em>$rootDirectory</em></td>
                <td>
                                  </td>
              </tr>
                      </tbody>
        </table>
      
      
      
      
      
        <a name="methodstartLayout" id="startLayout"><!-- --></a>

    <h3>startLayout</h3>

    <div class="method-signature">
      static void
      startLayout(
      )
    </div>

      <p>start layout</p>      
      
      
      
      
      
        <a name="methodstartMvc" id="startMvc"><!-- --></a>

    <h3>startMvc</h3>

    <div class="method-signature">
      static void
      startMvc(
      )
    </div>

      <p>start MVC</p>      
      
      
      
      
      
  
                                    
<p class="notes">
  Located in <a class="field" href="_Application.php.html">/Application.php</a> 
  [<span class="field">line 55</span>]
</p>

                <div class="credit">
                  Documentation generated on Fri, 16 Jan 2009 10:14:38 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.2</a>
                </div>
              </td>
            </tr>
          </table>
        </td>
      </tr>
    </table>
  </body>
</html>